<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>py2ecotect.ent.schedule.Schedule</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="py2ecotect-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >py2ecotect</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="py2ecotect-module.html">Package&nbsp;py2ecotect</a> ::
        <a href="py2ecotect.ent-module.html">Package&nbsp;ent</a> ::
        <a href="py2ecotect.ent.schedule-module.html">Module&nbsp;schedule</a> ::
        Class&nbsp;Schedule
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="py2ecotect.ent.schedule.Schedule-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Schedule</h1><p class="nomargin-top"><span class="codelink"><a href="py2ecotect.ent.schedule-pysrc.html#Schedule">source&nbsp;code</a></span></p>
<pre class="base-tree">
object --+
         |
        <strong class="uidshort">Schedule</strong>
</pre>

<hr />
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.schedule.Schedule-class.html#add" class="summary-sig-name">add</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">name</span>)</span><br />
      This command creates a new operational schedule within the current 
      model, and returns the zero-based index of the created schedule.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.schedule-pysrc.html#Schedule.add">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.schedule.Schedule-class.html#delete" class="summary-sig-name">delete</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">schedule</span>)</span><br />
      Deletes the specified schedule.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.schedule-pysrc.html#Schedule.delete">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.schedule.Schedule-class.html#load" class="summary-sig-name">load</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">filename</span>)</span><br />
      Loads the specified schedule library file .slf.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.schedule-pysrc.html#Schedule.load">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.schedule.Schedule-class.html#profile_read" class="summary-sig-name">profile_read</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">schedule</span>,
        <span class="summary-sig-arg">profile</span>,
        <span class="summary-sig-arg">filename</span>)</span><br />
      Reads the specified daily profile contained within a schedule from 
      the selected text-based 24 hour profile file (*.pfl).</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.schedule-pysrc.html#Schedule.profile_read">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.schedule.Schedule-class.html#profile_write" class="summary-sig-name">profile_write</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">schedule</span>,
        <span class="summary-sig-arg">profile</span>,
        <span class="summary-sig-arg">filename</span>)</span><br />
      Writes a daily profile to the schedule in the selected text-based 24 
      hour profile file (*.pfl).</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.schedule-pysrc.html#Schedule.profile_write">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.schedule.Schedule-class.html#read" class="summary-sig-name">read</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">schedule</span>,
        <span class="summary-sig-arg">filename</span>)</span><br />
      Reads from a schedule defined inside a text-based hourly schedule 
      data file (*.sch).</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.schedule-pysrc.html#Schedule.read">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.schedule.Schedule-class.html#save" class="summary-sig-name">save</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">filename</span>)</span><br />
      Saves a schedule library file (.slf) to the specified location.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.schedule-pysrc.html#Schedule.save">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.schedule.Schedule-class.html#write" class="summary-sig-name">write</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">schedule</span>,
        <span class="summary-sig-arg">filename</span>)</span><br />
      Saves a schedule to a text-based hourly schedule data file (*.sch).</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.schedule-pysrc.html#Schedule.write">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.schedule.Schedule-class.html#get_activation" class="summary-sig-name">get_activation</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">schedule</span>,
        <span class="summary-sig-arg">profile</span>,
        <span class="summary-sig-arg">hour</span>)</span><br />
      Retrieves the activation value of the specified profile within the 
      given schedule.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.schedule-pysrc.html#Schedule.get_activation">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.schedule.Schedule-class.html#set_activation" class="summary-sig-name">set_activation</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">schedule</span>,
        <span class="summary-sig-arg">profile</span>,
        <span class="summary-sig-arg">hour</span>,
        <span class="summary-sig-arg">value</span>)</span><br />
      Sets the activation value of the specified profile within the given 
      schedule.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.schedule-pysrc.html#Schedule.set_activation">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.schedule.Schedule-class.html#get_day" class="summary-sig-name">get_day</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">schedule</span>,
        <span class="summary-sig-arg">day</span>)</span><br />
      Retrieves the profile used for the specified day of the year.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.schedule-pysrc.html#Schedule.get_day">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.schedule.Schedule-class.html#set_day" class="summary-sig-name">set_day</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">schedule</span>,
        <span class="summary-sig-arg">day</span>,
        <span class="summary-sig-arg">profile</span>)</span><br />
      Sets the profile used for the specified day of the year.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.schedule-pysrc.html#Schedule.set_day">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.schedule.Schedule-class.html#get_index" class="summary-sig-name">get_index</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">name</span>)</span><br />
      Returns the zero-based index of the schedule specified by its name.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.schedule-pysrc.html#Schedule.get_index">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.schedule.Schedule-class.html#get_magnitude" class="summary-sig-name">get_magnitude</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">schedule</span>)</span><br />
      Retrieves the magnitude value assigned to the specified schedule.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.schedule-pysrc.html#Schedule.get_magnitude">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.schedule.Schedule-class.html#set_magnitude" class="summary-sig-name">set_magnitude</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">schedule</span>,
        <span class="summary-sig-arg">value</span>)</span><br />
      Sets the magnitude value assigned to the specified schedule.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.schedule-pysrc.html#Schedule.set_magnitude">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.schedule.Schedule-class.html#get_name" class="summary-sig-name">get_name</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">schedule</span>)</span><br />
      Retrieves the specified schedule's name.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.schedule-pysrc.html#Schedule.get_name">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.schedule.Schedule-class.html#set_name" class="summary-sig-name">set_name</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">schedule</span>,
        <span class="summary-sig-arg">name</span>)</span><br />
      Sets the name of the specified schedule.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.schedule-pysrc.html#Schedule.set_name">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.schedule.Schedule-class.html#get_profile_index" class="summary-sig-name">get_profile_index</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">schedule</span>,
        <span class="summary-sig-arg">name</span>)</span><br />
      Retrieves the index of a daily profile within the specified schedule.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.schedule-pysrc.html#Schedule.get_profile_index">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.schedule.Schedule-class.html#get_profile_name" class="summary-sig-name">get_profile_name</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">schedule</span>,
        <span class="summary-sig-arg">index</span>)</span><br />
      Retrieves the name of a daily profile within the specified schedule.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.schedule-pysrc.html#Schedule.get_profile_name">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.ent.schedule.Schedule-class.html#set_profile_name" class="summary-sig-name">set_profile_name</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">schedule</span>,
        <span class="summary-sig-arg">index</span>,
        <span class="summary-sig-arg">name</span>)</span><br />
      Sets the name of a daily profile within the specified schedule.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.ent.schedule-pysrc.html#Schedule.set_profile_name">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__delattr__</code>,
      <code>__getattribute__</code>,
      <code>__hash__</code>,
      <code>__init__</code>,
      <code>__new__</code>,
      <code>__reduce__</code>,
      <code>__reduce_ex__</code>,
      <code>__repr__</code>,
      <code>__setattr__</code>,
      <code>__str__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Properties</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Properties"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__class__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="add"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">add</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">name</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.schedule-pysrc.html#Schedule.add">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>This command creates a new operational schedule within the current 
  model, and returns the zero-based index of the created schedule.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>name A text string specifying the name of the new schedule.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="delete"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">delete</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">schedule</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.schedule-pysrc.html#Schedule.delete">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Deletes the specified schedule.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>schedule The zero-based index of the schedule or its name. The index 
  can be determined by using the get.schedule.index command or by viewing 
  the Schedule Editor dialog with sorting turned off.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="load"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">load</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">filename</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.schedule-pysrc.html#Schedule.load">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Loads the specified schedule library file .slf. Note that loading a 
  schedule library will replace all existing schedules in the model with 
  those in the library file.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>filename The full path to the library file to load.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="profile_read"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">profile_read</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">schedule</span>,
        <span class="sig-arg">profile</span>,
        <span class="sig-arg">filename</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.schedule-pysrc.html#Schedule.profile_read">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Reads the specified daily profile contained within a schedule from the
  selected text-based 24 hour profile file (*.pfl).</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>schedule The zero-based index of the schedule to read from.</p>
  <p>profile The index of the daily profile to read, being from 0-11.</p>
  <p>filename The full path to the profile file to read from.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="profile_write"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">profile_write</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">schedule</span>,
        <span class="sig-arg">profile</span>,
        <span class="sig-arg">filename</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.schedule-pysrc.html#Schedule.profile_write">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Writes a daily profile to the schedule in the selected text-based 24 
  hour profile file (*.pfl).</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>schedule The zero-based index of the schedule to write to.</p>
  <p>profile The index of the daily profile (0-11) to write to.</p>
  <p>filename The full path to where the profile file will be written.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="read"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">read</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">schedule</span>,
        <span class="sig-arg">filename</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.schedule-pysrc.html#Schedule.read">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Reads from a schedule defined inside a text-based hourly schedule data
  file (*.sch).</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>schedule The zero-based index of the schedule to read from. filename 
  The full path to the schedule data file to read from.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="save"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">save</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">filename</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.schedule-pysrc.html#Schedule.save">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Saves a schedule library file (.slf) to the specified location.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>filename The full path to where the schedule library file will be 
  written.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="write"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">write</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">schedule</span>,
        <span class="sig-arg">filename</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.schedule-pysrc.html#Schedule.write">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Saves a schedule to a text-based hourly schedule data file 
  (*.sch).</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>schedule The zero-based index to write to. filename The full path to 
  where the schedule data file will be written.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_activation"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_activation</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">schedule</span>,
        <span class="sig-arg">profile</span>,
        <span class="sig-arg">hour</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.schedule-pysrc.html#Schedule.get_activation">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the activation value of the specified profile within the 
  given schedule.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>schedule The zero-based index of the schedule.</p>
  <p>profile The zero-based index (0-11) of the profile.</p>
  <p>hour An integer between 0 and 23, where 0 is midnight on the previous 
  day and 23 is 11:00pm on the given day.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>activation A decimal value between 0 and 1.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_activation"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_activation</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">schedule</span>,
        <span class="sig-arg">profile</span>,
        <span class="sig-arg">hour</span>,
        <span class="sig-arg">value</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.schedule-pysrc.html#Schedule.set_activation">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the activation value of the specified profile within the given 
  schedule.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>schedule The zero-based index of the schedule.</p>
  <p>profile The zero-based index (0-11) of the profile.</p>
  <p>hour An integer between 0 and 23, where 0 is midnight on the previous 
  day and 23 is 11:00pm on the given day.</p>
  <p>value A decimal value between 0 and 1.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_day"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_day</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">schedule</span>,
        <span class="sig-arg">day</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.schedule-pysrc.html#Schedule.get_day">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the profile used for the specified day of the year.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>schedule The zero-based index of the schedule. day The julian date 
  given as an integer between 1 and 365. Return Value(s) Getting this 
  property returns the following value(s).</p>
  <p>index The zero-based daily profile index.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_day"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_day</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">schedule</span>,
        <span class="sig-arg">day</span>,
        <span class="sig-arg">profile</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.schedule-pysrc.html#Schedule.set_day">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the profile used for the specified day of the year.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>schedule The zero-based index of the schedule.</p>
  <p>day The julian date given as an integer between 1 and 365.</p>
  <p>profile The zero-based index of the profile, being a value between 0 
  and 11.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_index"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_index</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">name</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.schedule-pysrc.html#Schedule.get_index">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the zero-based index of the schedule specified by its name. If
  no matching name is found, an index of -1 is returned.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>name A string containing the name to match.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>index The zero-based index of the matching schedule.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_magnitude"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_magnitude</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">schedule</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.schedule-pysrc.html#Schedule.get_magnitude">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the magnitude value assigned to the specified schedule.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>schedule The zero-based index of the schedule.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>magnitude The schedule magnitude value.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_magnitude"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_magnitude</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">schedule</span>,
        <span class="sig-arg">value</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.schedule-pysrc.html#Schedule.set_magnitude">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the magnitude value assigned to the specified schedule.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>schedule The zero-based index of the schedule.</p>
  <p>value Magnitudes are not currently used within ECOTECT, but will be 
  when exporting schedules to other external applications. The magnitude 
  values will be user-defined and depend on the specific application of the
  schedule in each application.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_name"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_name</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">schedule</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.schedule-pysrc.html#Schedule.get_name">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the specified schedule's name.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>schedule The zero-based index of the schedule.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>name A string of up to 128 characters in length.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_name"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_name</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">schedule</span>,
        <span class="sig-arg">name</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.schedule-pysrc.html#Schedule.set_name">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the name of the specified schedule.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>schedule The zero-based index of the schedule.</p>
  <p>name A string of up to 128 characters in length.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_profile_index"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_profile_index</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">schedule</span>,
        <span class="sig-arg">name</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.schedule-pysrc.html#Schedule.get_profile_index">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the index of a daily profile within the specified 
  schedule.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>schedule The zero-based index of the schedule.</p>
  <p>name A string representing the name of the profile.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>index The zero-based daily profile index.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_profile_name"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_profile_name</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">schedule</span>,
        <span class="sig-arg">index</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.schedule-pysrc.html#Schedule.get_profile_name">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the name of a daily profile within the specified 
  schedule.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>schedule The zero-based index of the schedule.</p>
  <p>index An integer between 0 and 11 representing the zero-based index of
  the profile to use.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>name A string representing the name of the profile.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_profile_name"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_profile_name</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">schedule</span>,
        <span class="sig-arg">index</span>,
        <span class="sig-arg">name</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.ent.schedule-pysrc.html#Schedule.set_profile_name">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the name of a daily profile within the specified schedule.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>schedule The zero-based index of the schedule.</p>
  <p>index An integer between 0 and 11 representing the zero-based index of
  the profile to use.</p>
  <p>name A text string containing the new profile name.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="py2ecotect-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >py2ecotect</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Fri Aug 28 01:29:48 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
